/*
 * Copyright (c) 2009 DeledImporter
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'Pyro Games' nor the names of its contributors 
 *   may be used to endorse or promote products derived from this software 
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package net.pyrogames.deled.geometry;

import net.pyrogames.deled.math.DXSVector3f;

/**
 * Spatial represents a base class for DeleD scene data or 
 * other custom elements defined by the user. All spatials
 * have at least a name and a parent (unless if its a root).
 * 
 * @author Nicholas Woodfield
 *
 */
public abstract class DXSSpatial {
	/** Name of the node */
	private String name;
	/** Parent of the node */
	private DXSSpatial parent;
	/** Location of the spatial in 3d space */
	private DXSVector3f location;
	/** Direction the spatial is facing in 3d space */
	private DXSVector3f direction;
	
	public DXSSpatial(String spatialName){
		name = spatialName;
		parent = null;
		location = new DXSVector3f(0,0,0);
		direction = new DXSVector3f(0,0,1);
	}
	
	/**
	 * Return the name of this spatial.
	 * 
	 * @return
	 * 		Spatial's name
	 */
	public String getName(){
		return name;
	}
	
	/**
	 * Get the parent of this spatial.
	 * 
	 * @return
	 * 		Parent spatial
	 */
	public DXSSpatial getParent(){
		return parent;
	}
	
	/**
	 * Set the name of this spatial.
	 * 
	 * @param spatialName
	 * 		New name for the spatial
	 */
	public void setName(String spatialName){
		name = spatialName;
	}
	
	/**
	 * Set this node's parent with the specified spatial.
	 * 
	 * @param n
	 * 		New parent of this spatial
	 */
	public void setParent(DXSSpatial s){
		parent = s;
	}
	
	/**
	 * Set the direction that this spatial should face
	 * 
	 * @param
	 * 		direction of spatial
	 */
	public void setdirection(DXSVector3f v){
		direction = v;
		direction.normalizeLocal();
	}
	
	/**
	 * Get the direction that this spatial faces
	 * 
	 * @return
	 * 		orientation of spatial
	 */
	public DXSVector3f getDirection(){
		return direction;
	}
	
	/**
	 * Set the location of this spatial in 3D space
	 * 
	 * @param v
	 * 		location of spatial
	 */
	public void setLocation(DXSVector3f v){
		location = v;
	}
	/**
	 * Get the location of this spatial in 3D space
	 * 
	 * @return
	 * 		location of spatial
	 */
	public DXSVector3f getLocation(){
		return location;
	}
}
